Description

Disclaimer

Requirements

Instructions

Credits

GUI Editor
Powered by W4st's Weapons Editor V2.4
JA2 Desktop Version 1.00


Description

This program will allow you to make changes to the "MyWeapons.txt" file supported through W4st's Weapon Editor without the use of a Spreadsheet.


Disclaimer

This program is Freeware and may be distributed freely as long as all files remain intact.  The author of this program accepts no responsibility for any damage or harm resulting in the use of this program.  Use this program at your own risk.

JA2 Utilities created by this author are designed for immediate use and have limited (or no) documentation and/or error checking routines.  Updates are only released when they fulfill a need for the author.


Requirements

It is recommended that you understand the fields and options available for W4st's Weapons Editor.  View the "W4st's Weapon Editor" Help file (under HELP) to learn more.

This program was designed to take some of the calculation work out of the Modding process and allow for a more "visual" representation of a weapon or item.


Instructions

This program will load an existing Weapons Text file compatible with W4st's 2.4 Editor.  It is not "backward" compatible which means your file must already be in the 2.4 format to utilize it in this editor.

To obtain a 2.4 version, patch your weapons file to the JA2.EXE or JA2UB.EXE file, then use the GUI Editor's "Configure/Extract" Menu Option to extract a new file to the 2.4 version.  Otherwise, you may simply start creating a new weapons mod from scratch.

 

Loading an Existing Weapons MOD:
Select "File/Open" from the Menu Bar and open your existing (Version 2.4) weapons MOD.  The program will automatically recognize JA2 or JA2UB files.

Creating a New Weapons MOD:
Select "File/New" from the Menu Bar, then select JA2 or JA2UB Weapons MOD.  This will give you a "fresh" file with no modifications.

Editing Weapons and Items:
After creating a new file or opening an existing file, you will be presented with the "Weapons" Window.  Using the Blue Arrow Tools on the Tool Bar you can move from one record to another.  You may also select the "Item Drop Down List" (yellow field) to scroll through the items and select your choice.

In the upper left-hand corner of the Weapons Window you will see the "View Section" field.  The GUI Editor is divided into sections which allow you to easily "jump" from one group to another and view multiple sections at once.

Click on the "View Section" Drop Down Menu and select the appropriate section to view buy clicking on the item.  A new window will appear displaying the appropriate information.

The GUI Editor has been designed to take some of the "calculation" work out of designing a mod.  Many of the fields contain "Drop Down Lists" for you to select from rather than cross-referencing a code.  However, some do still contain codes.

The ToolBar:
From Left to Right.

New: Allows you to create new projects (Weapons, NPCs, etc...)

Open: Allows you to open a new project.

Save: Save the current project. (Window)

Cut: Cut the selected text to the clipboard and delete from the current field.

Copy: Copy the selected text to the clipboard.

Paste: Paste the clipboard to the current field.

Copy Record: Copies an Entire Record to the Internal Program Clipboard (does not work in all programs).

Paste Record: Overwrites the existing record with the record stored on the Internal Program Clipboard (does not work for all programs).

Swap Record 1, Swap Record 2 and Swap Records: These buttons allow you to orchestrate the "Swapping" of two records in a Weapons File. 

For Example:

If you wish to change the placement (in the file) of records 1 and records 15, you would Move to Record 1 and click the "Swap Record 1" Button, then move to Record 15 and Select the "Swap Record 2" Button.  When both records are selected, clicking the "Swap Records 1 & 2" Button will switch their locations in the file.  Note: The Bottom Status Bar will update you on the selections you have made for the Swap Operation. Also, this swap function will not affect the "Special Offset" Field.

Refresh: Refreshes all of the fields and drop down list boxes in the current view.

First Record, Prev Record, Next Record and Last Record: These buttons allow you to navigate through a file.

Exit: Exits the Program.

Please refer to the Help Section for information on these fields and the possible values they may contain.

 

Configure Menu Option:

Under the Configure Menu Option, you may perform the following:

Patch File: Will patch the currently loaded Weapons file to the user selected JA2.EXE or JA2UB.EXE file.

Extract File: Will extract the weapons and items information from an existing JA2.EXE or JA2UB.EXE file to a user supplied .txt filename.

Apply Burst Bug Patch: Will apply the W4st Burst Bug Patch to the user selected .EXE File.

Options:

The JA2Desktop utility was designed to be the "One Stop Shop" for your JA2 Modding needs.  Therefore, this option has been added to allow you to add your favorite utilities to the JA2Desktop and launch them from within the program.

Whenever you select "File/New", a New Window will appear asking for the program to start.  By adding your other utilities here, you can start them from the same option.

To Add a New Program, click the "NEW" button.  Enter the Program Name and the Program Path.  Note: The program path must be "relative" to the JA2Desktop Path. Click the "Update" Button to save your changes.

 

Weapons Compare File:

A useful function is to be able to compare two weapons files together.  Although you cannot open multiple files for editing, you can open a second "Compare" file for viewing.

Click on "File/Open" and Select the "Items/Weapons Compare File" from the list.  You will be prompted for the filename.  When the file is loaded, a new window will appear displaying the Compare File's Contents based on the current record you are viewing.  To verify that the records are displaying the same index, click the "Sync" button to sync it to your current record.


Credits

Author: Batman
Date: January, 2003

Special Thanks:
This program was developed during the project "Urban Chaos" and special thanks go out to the JA2 MOD Squad, BETA Testers and all those who assisted.

For questions or comments related to this utility, please visit the Bear's Pit Forum.